Autogenerated HTML docs for v1.5.6.1-156-ge903b
diff --git a/git-gc.txt b/git-gc.txt index 6ace615..0cce389 100644 --- a/git-gc.txt +++ b/git-gc.txt
@@ -8,14 +8,14 @@ SYNOPSIS -------- -'git-gc' [--aggressive] [--auto] [--quiet] +'git gc' [--aggressive] [--auto] [--quiet] DESCRIPTION ----------- Runs a number of housekeeping tasks within the current repository, such as compressing file revisions (to reduce disk space and increase performance) and removing unreachable objects which may have been -created from prior invocations of linkgit:git-add[1]. +created from prior invocations of `git-add`. Users are encouraged to run this task on a regular basis within each repository to maintain good disk space utilization and good @@ -33,15 +33,15 @@ ------- --aggressive:: - Usually 'git-gc' runs very quickly while providing good disk + Usually `git-gc` runs very quickly while providing good disk space utilization and performance. This option will cause - git-gc to more aggressively optimize the repository at the expense + `git-gc` to more aggressively optimize the repository at the expense of taking much more time. The effects of this optimization are persistent, so this option only needs to be used occasionally; every few hundred changesets or so. --auto:: - With this option, `git gc` checks whether any housekeeping is + With this option, `git-gc` checks whether any housekeeping is required; if not, it exits without performing any work. Some git commands run `git gc --auto` after performing operations that could create many loose objects. @@ -89,7 +89,7 @@ kept. This defaults to 15 days. The optional configuration variable 'gc.packrefs' determines if -`git gc` runs `git-pack-refs`. This can be set to "nobare" to enable +`git-gc` runs `git-pack-refs`. This can be set to "nobare" to enable it within all non-bare repos or it can be set to a boolean value. This defaults to true. @@ -108,10 +108,10 @@ Notes ----- -git-gc tries very hard to be safe about the garbage it collects. In +`git-gc` tries very hard to be safe about the garbage it collects. In particular, it will keep not only objects referenced by your current set of branches and tags, but also objects referenced by the index, remote -tracking branches, refs saved by linkgit:git-filter-branch[1] in +tracking branches, refs saved by `git-filter-branch` in refs/original/, or reflogs (which may references commits in branches that were later amended or rewound).
